Inside Macintosh: QuickDraw GX Graphics /

Chapter 3 - Geometric Styles / Geometric Styles Reference

Functions / Getting and Setting Caps

GXSetStyleCap

You can use the GXSetStyleCap function to change the cap information of a style object.

void GXSetStyleCap(gxStyle target, const gxCapRecord *cap);

target

The style object whose cap information you want to change.

cap

A pointer to the new cap information.

DESCRIPTION

The GXSetStyleCap function replaces the cap information in the style object specified by the target parameter with the cap information specified in the cap parameter. You use the gxCapRecord structure to provide cap information.

Passing nil for the cap parameter indicates that you want no caps and QuickDraw GX removes any cap information from the target style.

When you set a style's cap property using this function, you are effectively changing the caps for all shapes that share the style.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
style_is_nil
parameter_out_of_range	(debugging version)
empty_shape_not_allowed	(debugging version)
ignorePlatformShape_not_allowed	(debugging version)
illegal_type_for_shape	(debugging version)
nil_style_in_glyph_not_allowed	(debugging version)
complex_glyph_style_not_allowed	(debugging version)
shapeFill_not_allowed	(debugging version)
Notices (debugging version)
caps_already_set
tags_in_shape_ignored

SEE ALSO

For a discussion of start and end caps, see "Caps" on page 3-23.

For examples of adding caps to a shape, see "Adding Caps to a Shape" on page 3-57 and "Adding Standard Caps to a Shape" on page 3-59.

For a discussion of the gxCapRecord structure and a description of what types of shapes you can use as cap shapes, see "The Cap Structure" on page 3-99.

To retrieve cap information from a style object, use the GXGetStyleCap function, which is described on page 3-124.

To retrieve cap information from a style object associated with a particular shape, use the GXGetShapeCap function, which is described in the next section. To specify cap information for a style object associated with a particular shape, use the GXSetShapeCap function, which is described on page 3-128.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help